home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / bbdice14.zip / BBDICE.DOC < prev    next >
Text File  |  1992-10-15  |  19KB  |  419 lines

  1.  
  2.                              BASEBALL DICE    
  3.  
  4.                                   v1.4
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    Baseball Dice plays pretty much like a regular game of baseball, with the 
  21.    exception that you use dice to "hit" the ball and we do not count the balls
  22.    and strikes (ie: 1 strike = a strikeout AND 1 ball = a walk).
  23.  
  24.    The object of the game is to beat the game score that you, the Sysop, have 
  25.    already posted.  NOTE: Ties lose!
  26.  
  27.  
  28.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  29.          created in the directory you run the door from.
  30.  
  31.  
  32.  
  33.                               INSTALLATION
  34.                               ____________
  35.  
  36.  
  37.    Installation is fairly easy and straight-forward. The following steps and
  38.    examples should have you up and running in a very short period of time.
  39.    It is assumed that you are familiar with setting up DOORS on your system.
  40.    To this end, only examples of the configuration file and Door batch file
  41.    are described.
  42.  
  43.       1) Create a directory to hold all BBDICE files
  44.  
  45.       2) Unzip BBDICExx.ZIP into the the above directory
  46.  
  47.          NOTE: BRUN45.EXE is not included but is required !!!
  48.  
  49.       3) Create a configuration file, with a name of your choice, or
  50.          modify the supplied BBDICE.CFG file. A description follows:
  51.  
  52.             **                       Location of system file (See Below)
  53.             SUNRISE-80 BBS           Your BBS Name
  54.             Al                       Sysop's First nameAP
  55.  
  56.             Lawrence                 Sysop's Last Name
  57.  
  58. |-----------------------------------------------------------------------------|
  59. | READ!     1                        CommPort  \ These 2 lines are required   |
  60. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  61. |-----------------------------------------------------------------------------|
  62.  
  63.             00000000                 Registration Number
  64.  
  65.     !   #   1                        Maximum # of Games per day
  66.                                      (Sysop gets 99, Registered version ONLY)
  67.  
  68.             50                       Number of Top Score entries.
  69.                                      Minimum = 10, Maximum = 99.
  70.  
  71.         #   NONE                     Drive:\Path\Filename to contain the
  72.                                      Top Score Bulletin or enter NONE
  73.                                      for NO Bulletin creation.
  74.  
  75.         #   NONE                     Drive:\Path\Filename to contain the
  76.                                      Top Score Bulletin (Color) or enter NONE
  77.                                      for NO Bulletin creation.
  78.  
  79.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  80.                                      2 = Display ADOPT-A-DOOR message
  81.  
  82.         #   2                        Keyboard timeout value in Minutes
  83.  
  84.     !   #   0                        Time allowed in Door
  85.                                      (Sysop = Time Remaining - REG. VERSION)
  86.  
  87.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  88.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  89.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  90.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  91.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  92.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  93.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  94.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  95.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  96.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  97.     @   #   XXXX/YYYY                 Blackout Range  From/To
  98.     @   #   XXXX/YYYY                 Blackout Range  From/To
  99.     @   #   XXXX/YYYY                 Blackout Range  From/To
  100.     @   #   XXXX/YYYY                 Blackout Range  From/To
  101.     @   #   XXXX/YYYY                 Blackout Range  From/To
  102.  
  103.  
  104.      
  105.               ** = Replace with ONE of the following:
  106.  
  107. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  108. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  109. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  110.                                    (Note:DOOR.SYS must be in SAME directory)
  111. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  112. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  113. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  114. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  115. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  116. C:\BBS\GTUSER.BBS               <- For GT Power 
  117.                                    * if using this option you must put the
  118.                                      ComPort # on line 5 and the Node # on
  119.                                      line 6 of the configuration file
  120.  
  121.  
  122.  
  123.  
  124.            # = Requires registration to change to a different value.
  125.            ! = See "Plays Per Day" Below
  126.            @ = See "Blackout Periods" Below
  127.  
  128.                NOTE: There are NO Blank Lines in the Config File!!
  129.  
  130.  
  131.  
  132.  
  133.       4) Create a batch file or modify the BBDICE file supplied. A
  134.          description of this file follows:
  135.  
  136.             ECHO off
  137.             cd\PCB\DOORS\BBDICE       Location of BBDICE files
  138.             BBDICE  BBDICE.CFG        EXE filename and CFG filename (Name
  139.                                       used in creating file in #3 above)
  140.             CD\PCB
  141.             BOARD
  142.  
  143.  
  144.        5) When running in more than one node, be sure to supply a
  145.           different configuration name for each node (your choice of name).
  146.  
  147.  
  148.   
  149.                          TEAM ROSTER FILE
  150.                          ________________
  151.     
  152.       You must have a file called BBDICE.ROS in your directory. This file
  153.       contains the team line-up. You can have a maximum of 9 entries, with
  154.       no entry longer than 33 characters. 
  155.  
  156.  
  157.  
  158.                           BLACKOUT PERIODS
  159.                           ________________
  160.  
  161.       Use the Blackout ranges option to define up to 5 time periods during
  162.       which you DO NOT want the Door to be played. If a caller tries to access 
  163.       the Door during the Blackout period, they will be shown a message that
  164.       contains ALL the Blackout periods you have defined, and to try the Door
  165.       at a later time.
  166.  
  167.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  168.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  169.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  170.  
  171.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  172.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  173.                    a Blackout range.
  174.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  175.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  176.  
  177.  
  178.  
  179.                           PLAYS Per DAY/DOOR Time
  180.                           _______________________
  181.  
  182.       Plays Per Day and Door Time can be controlled several ways:
  183.  
  184.       (1) You can use the Games Per Day, singular option, in the config
  185.           file above. This option, will affect ALL callers whose Security
  186.           Level is NOT defined in any of the 10 optional Security Level/
  187.           Plays Per Day entries in the config file.
  188.  
  189.       (2) You can use the Door Time, singular option, in the config file
  190.           above. This option, will affect ALL callers whose Security
  191.           Level is NOT defined in any of the 10 optional Security Level/
  192.           Plays Per Day/Door Time entries in the config file.
  193.  
  194.       (3) You can restrict the number of games a specific Security Level
  195.           will be allowed to play per day or REWARD specific Levels with 
  196.           more Plays Per Day. 
  197.  
  198.           Likewise, you can restrict the Play time for a specific Security
  199.           Level or REWARD specific Levels with more Door Time.
  200.  
  201.           These options are handled by the use of the 10 config 
  202.           entries (000=00/00). 
  203.           
  204.           The format of each entry is as follows:
  205.  
  206.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  207.                      where =  is a constant and MUST be included
  208.                      where YY is the # of games per day (must be 2 digits)
  209.                      where / is a constant and MUST be included
  210.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  211.           
  212.           If the callers Security Level is NOT defined, his/her Plays Per
  213.           Day and Door Time will be controlled by the values in items
  214.           (1) and (2), above, respectively..
  215.  
  216.           You may define up to 10 Security Levels. All unused entries must
  217.           be defined as   000=00/00
  218.         --------------------------------------------------------------------
  219.           Example: Suppose you had 3 Security Levels defined on your BBS as
  220.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  221.           wanted to set Plays Per Day as :     Subscriber=5
  222.                                            Visiting Sysop=2
  223.                                                   CoSysop=3
  224.                                                    Friend=10 
  225.           
  226.           and Door Time as follows:     Subscriber=30 minutes
  227.                                     Visiting Sysop=20 minutes
  228.                                            CoSysop=10 minutes 
  229.                                             Friend=remaining call time
  230.                                
  231.  
  232.           You would set the Individual "Games per Day" config entry to 1 and 
  233.           the individual "Door Time" to 5 minutes (these would be the 
  234.           default number of games and default Time for all Security Levels
  235.           other than 20,30 or 40... make them any number you want). Next you
  236.           would replace 4 of the Security Level entries as :  020=05/30                                               
  237.                                                               030=02/20
  238.                                                               040=03/10
  239.                                                               090=10/0
  240.  
  241.  
  242.                         NON-STANDARD COM SUPPORT
  243.                         ________________________
  244.  
  245.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  246.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  247.       number after the configuration filename. Let's assume your Door is
  248.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  249.       passed to your Door would be:
  250.  
  251.                             FOOBAR FOOBAR.CFG /5
  252.  
  253.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  254.       normally used with COM1. No /x parameter is needed for the standard
  255.       IRQ's.
  256.  
  257.       As an alternative, you may use an environmental variable on the command
  258.       line. To use the variable (following the example above), place a 
  259.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  260.       different IRQ number for each node). The command line would now look 
  261.       like this: 
  262.  
  263.                           FOOBAR FOOBAR.CFG /%IRQ%
  264.       
  265.       This, in combination with the use of the environmental variables 
  266.       described in the MULTI-NODE SETUP section will allow you to use one 
  267.       batch file and one config file to run this door on all nodes.
  268.  
  269.  
  270.  
  271.  
  272.                            MULTI-NODE SETUP
  273.                            ________________
  274.  
  275.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  276.       ability to access a configuration file which will have its own system 
  277.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  278.       line. There are 2 ways to accomplish this:
  279.  
  280.       (1) Create a separate configuration file for each node. The only 
  281.           difference between each file would be the location of the system 
  282.           file for that particular node. For example, on my system there are 2
  283.           nodes and the first line of the config files would look like this:
  284.  
  285.                         NODE1:  H:\PCB1\DOOR.SYS
  286.                         NODE2:  H:\PCB2\DOOR.SYS
  287.  
  288.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  289.  
  290.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  291.           the following PCBoard environmental variables:
  292.  
  293.                  PCBDIR    (Directory containing the System file)
  294.                  PCBDRIVE  (Drive containing the System file)
  295.  
  296.           Thus, the first line of the SINGLE configuration file, for this Door
  297.           would look like this:
  298.  
  299.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  300.  
  301.       NOTE: This option, as described, assumes that you are running PCBoard 
  302.             14.5a software. The environmental variables are automatically 
  303.             created by the software for each node.
  304.  
  305.             HOWEVER, if you are running other BBS software you should be able
  306.             to set the variables EXACTLY as described below, for EACH node 
  307.             (more than likely in each batch file you use to bring up EACH node):
  308.  
  309.                             PCBDRIVE=C:
  310.                             ^^^^^^^^^
  311.                             PCBDIR=\NODE2
  312.                             ^^^^^^^^
  313.             
  314.             Info with a carat (^) under it, MUST be typed as is. The rest 
  315.             depends on your naming conventions. 
  316.  
  317.             This, in combination with the use of the optional environmental
  318.             variable described in the NON-STANDARD COM SUPPORT section, will
  319.             allow you to use one batch file and one config file to run this 
  320.             door on all nodes.
  321.  
  322.  
  323.                                ADOPT-A-DOOR
  324.                                ____________
  325.  
  326.     Having been a Sysop for a number of years, I have had my share of problems
  327.     and frustrations getting financial support for my board's upkeep. A fellow
  328.     Sysop left a message on my board, not long ago, about a concept that was
  329.     being used by several boards around the country.
  330.  
  331.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  332.     would be the same as sending in a donation, only this way it is earmarked
  333.     for registering a particular door. In a way, the user feels he/she is
  334.     "getting something in return". As a Door author I have decided to build
  335.     this concept into each of my Door programs. The concept replaces the
  336.     usual message "tell the Sysop to register this Door" we find in most
  337.     doors.
  338.  
  339.     If the Door is unregisterd then a message appears on the opening screen
  340.     to that effect. After finishing or suspending a game, a message screen
  341.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  342.     caller to contact the Sysop to find out if there is any further details
  343.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  344.     time, etc to callers that ADOPT-A-DOOR.
  345.  
  346.     If the Door has been registered, either by the Sysop or other callers,
  347.     the names of those contributors will be displayed in the closing screen.
  348.  
  349.     NOTE: If you want to display the names of the callers that contributed
  350.           to registering the Door, you must create an ASCII file called
  351.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  352.           the name(s) of the contributors (one on each line, maximum of 5
  353.           entries, each a maximum of 30 characters long). This file must be
  354.           saved, in ASCII format, and placed in the Door directory.
  355.  
  356.  
  357.  
  358.                               LEGALITIES
  359.                               __________
  360.  
  361.  
  362.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  363.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  364.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  365.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  366.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  367.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  368.       OR BREACH OF ANY WARRANTY.
  369.  
  370.  
  371.  
  372.  
  373.  
  374.                              DISTRIBUTION
  375.                              ____________
  376.  
  377.    You may make this file available for downloading from your BBS or you may
  378.    upload it to any BBS of your choice, provided that you do not make any
  379.    changes to the contents of the archive (ZIP file). The archive and its
  380.    individual contents may not be used by any service that charges any money
  381.    whatsoever, without the written permission of the author.
  382.  
  383.  
  384.  
  385.  
  386.  
  387.                              REGISTRATION
  388.                              ____________
  389.  
  390.    Registration and the subsequent insertion of the registration number into
  391.    your configuation file, allows for the display of your BBS name on the
  392.    opening and closing screen as well as the reduction of a delay built into
  393.    the opening screen display along with the ability to change certain
  394.    values in the configuration file.
  395.  
  396.    To register your copy of BBDICE, please fill out the registration form
  397.    (REGISTER.FRM) and mail it along with the registration form to
  398.    the name and address on the form.
  399.  
  400.    Be sure to use the proper upper/lower case when filling in your name and
  401.    BBS name, as they MUST match the way you entered them in the configuration
  402.    file.             ^^^^
  403.  
  404.    Based upon information supplied on the registration form, I will pre-
  405.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  406.    up your registration number.
  407.  
  408.  
  409.  
  410.                                  MISC
  411.                                  ____
  412.  
  413.    The latest version of BASEBALL DICE and other fine SUNRISE DOOR programs
  414.    are always available for download from SUNRISE-80 BBS.
  415.  
  416.    Remember, should you have any problems, questions or suggestions, be sure
  417.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  418.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) OR Fido 1:133/604
  419.